[TRTLLM-9092][doc] Add a pre-quantized example in quick start guide by QiJune · Pull Request #9223 · NVIDIA/TensorRT-LLM

QiJune · 2025-11-17T13:02:12Z

Summary by CodeRabbit

Documentation
- Enhanced quick-start guide with instructions for deploying pre-quantized models using FP8 precision. Includes sample deployment commands and important precautions regarding FP8 support to assist users with proper model deployment procedures.

Description

Test Coverage

PR Checklist

Please review the following before submitting your PR:

PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
Update tava architecture diagram if there is a significant design change in PR.
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.

GitHub Bot Help

/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...

Provide a user friendly way for developers to interact with a Jenkins server.

Run /bot [-h|--help] to print this help message.

See details below for each supported subcommand.

Details

run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]

Launch build/test pipelines. All previously running jobs will be killed.

--reuse-test (optional)pipeline-id (OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.

--disable-reuse-test (OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.

--disable-fail-fast (OPTIONAL) : Disable fail fast on build/tests/infra failures.

--skip-test (OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.

--stage-list "A10-PyTorch-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.

--gpu-type "A30, H100_PCIe" (OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.

--test-backend "pytorch, cpp" (OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.

--only-multi-gpu-test (OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.

--disable-multi-gpu-test (OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.

--add-multi-gpu-test (OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.

--post-merge (OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.

--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".

--detailed-log (OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.

--debug (OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in the stage-list parameter to access the appropriate container environment. Note: Does NOT update GitHub check status.

For guidance on mapping tests to stage names, see docs/source/reference/ci-overview.md
and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip testing for latest commit on pull request. --comment "Reason for skipping build/test" is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

reuse-pipeline

reuse-pipeline

Reuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

Signed-off-by: junq <22017000+QiJune@users.noreply.github.com>

coderabbitai · 2025-11-17T13:05:13Z

📝 Walkthrough

Walkthrough

Documentation updated to include deployment guidance for pre-quantized FP8 models, featuring sample commands and FP8 support precautions. No functional or runtime behavior changes.

Changes

Cohort / File(s)	Summary
Quick-start deployment documentation `docs/source/quick-start-guide.md`	Added instructions for deploying pre-quantized models with FP8 quantization, including example deployment command and important caveats regarding FP8 support compatibility.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Verify accuracy of the FP8 deployment command syntax and parameters
Confirm FP8 support precautions are technically correct and complete
Ensure consistency with existing documentation tone and formatting

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is missing critical required sections. Only the template boilerplate is present with empty Description and Test Coverage sections, and an unchecked PR Checklist.	Complete the Description section explaining what changes are being made and why. Specify relevant test coverage. Fill in the PR title with proper format: [TICKET][type] Summary. Complete the PR Checklist verification.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title correctly follows the repository template with [JIRA ticket][type] format and clearly describes the main change: adding a pre-quantized example to the quick start guide documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

QiJune · 2025-11-19T01:13:38Z

/bot skip --comment "doc changes"

tensorrt-cicd · 2025-11-19T01:19:51Z

PR_Github #24955 [ skip ] triggered by Bot. Commit: 71925a7

tensorrt-cicd · 2025-11-19T01:35:59Z

PR_Github #24955 [ skip ] completed with state SUCCESS. Commit: 71925a7
Skipping testing for commit 71925a7

…VIDIA#9223) Signed-off-by: junq <22017000+QiJune@users.noreply.github.com>

…VIDIA#9223) Signed-off-by: junq <22017000+QiJune@users.noreply.github.com> Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com>

…VIDIA#9223) Signed-off-by: junq <22017000+QiJune@users.noreply.github.com> Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com> Signed-off-by: Mike Iovine <miovine@nvidia.com>

…VIDIA#9223) Signed-off-by: junq <22017000+QiJune@users.noreply.github.com> Signed-off-by: Mike Iovine <6158008+mikeiovine@users.noreply.github.com> Signed-off-by: Mike Iovine <miovine@nvidia.com> Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>

Add a pre-quantized example in quick start guide

71925a7

Signed-off-by: junq <22017000+QiJune@users.noreply.github.com>

QiJune requested a review from a team as a code owner November 17, 2025 13:02

QiJune requested review from a-mccarthy and laikhtewari November 17, 2025 13:02

QiJune assigned chenopis Nov 17, 2025

QiJune requested a review from nv-guomingz November 17, 2025 13:02

QiJune added the Doc <NV>TRTLLM's textual/illustrative materials: API refs, guides, tutorials. Improvement & clarity. label Nov 17, 2025

LarryXFly approved these changes Nov 18, 2025

View reviewed changes

QiJune enabled auto-merge (squash) November 19, 2025 01:14

QiJune merged commit a49fdb3 into NVIDIA:release/1.1 Nov 19, 2025
8 of 9 checks passed

mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Nov 20, 2025

[TRTLLM-9092][doc] Add a pre-quantized example in quick start guide (N…

e419274

…VIDIA#9223) Signed-off-by: junq <22017000+QiJune@users.noreply.github.com>

mikeiovine pushed a commit to mikeiovine/TensorRT-LLM that referenced this pull request Nov 20, 2025

[TRTLLM-9092][doc] Add a pre-quantized example in quick start guide (N…

cd20c50

…VIDIA#9223) Signed-off-by: junq <22017000+QiJune@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TRTLLM-9092][doc] Add a pre-quantized example in quick start guide#9223

[TRTLLM-9092][doc] Add a pre-quantized example in quick start guide#9223
QiJune merged 1 commit intoNVIDIA:release/1.1from
QiJune:polish_quant

QiJune commented Nov 17, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 17, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Uh oh!

QiJune commented Nov 19, 2025

Uh oh!

tensorrt-cicd commented Nov 19, 2025

Uh oh!

tensorrt-cicd commented Nov 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

QiJune commented Nov 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Description

Test Coverage

PR Checklist

GitHub Bot Help

kill

skip

reuse-pipeline

Uh oh!

coderabbitai bot commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

QiJune commented Nov 19, 2025

Uh oh!

tensorrt-cicd commented Nov 19, 2025

Uh oh!

tensorrt-cicd commented Nov 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

QiJune commented Nov 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 17, 2025 •

edited

Loading